home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 033a / cbox13.zip / SET_F10.DOC < prev    next >
Text File  |  1991-12-20  |  14KB  |  312 lines
  1.          
  2.  
  3.  
  4.  
  5.  
  6.          ------------------------------------------------------------------
  7.         |                                                                  |
  8.         |                                                                  |
  9.         |                                                                  |
  10.         |                        Set_F10 Version 1.3                       |
  11.         |                                                                  |
  12.         |                        TSR F10 Key Handler                       |
  13.         |                                                                  |
  14.         |                               For                                |
  15.         |                                                                  |
  16.         |               ChatBox - Split Screen Page\Chat Door              |
  17.         |                                                                  |
  18.         |                                                                  |
  19.         |     Set_F10   (C) Copyright 1991   Yandell Computer Services     |
  20.         |     ChatBox   (C) Copyright 1991   Yandell Computer Services     |
  21.         |                                                                  |
  22.         |             12121 Little Road - Bldg. 303 - Suite 212            |
  23.         |                        Hudson, FL 34667                          |
  24.         |                                                                  |
  25.         |                   DATA -- (813) 842-8099 (HST)                   |
  26.         |                                                                  |
  27.         |                        December 20, 1991                         |
  28.         |                                                                  |
  29.         |                                                                  |
  30.          ------------------------------------------------------------------ 
  31.  
  32.  
  33.  
  34.  
  35.                                  TABLE OF CONTENTS                      Page
  36.                                  -----------------                      ----
  37.  
  38.               INTRODUCTION                                                
  39.               ------------
  40.               1.0  What Is Set_F10                                         2
  41.               1.1  Disclaimer                                              2
  42.                
  43.               INSTALLING Set_F10
  44.               ------------------
  45.               2.0  Installing Set_F10 in BOARD.BAT                         3
  46.               2.1  Installing if ChatBox Door Name is not PAGE             3
  47.                             
  48.               RUN-TIME CONSIDERATIONS
  49.               -----------------------
  50.               3.0  Using Set_F10                                           4
  51.               3.1  F10 Key Use With Other Programs                         4
  52.               3.2  In Case of Difficulty                                   4
  53.    
  54.               MISCELLANEOUS
  55.               ------------- 
  56.               4.0  DOS "errorlevel" Use in BOARD.BAT                       5
  57.               4.1  Technical Notes                                         5
  58.                  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.         --------------------------------------------------------------------
  70.         Page 2                        Set_F10                         Page 2
  71.         --------------------------------------------------------------------
  72.  
  73.         1.0  What is Set_F10
  74.         --------------------
  75.         Use  of Set_F10 is completely optional and is in no way required for 
  76.         the ChatBox door program to be fully functional.
  77.  
  78.         Set_F10  is  a TSR which traps local F10 key presses and allows  the 
  79.         Sysop to choose ChatBox or PCBoard to chat with a caller. This is an
  80.         enhancement over the ChatBox documented method of defining SHIFT-F10
  81.         for the Sysop to initiate the PAGE command, then hitting a key while 
  82.         ChatBox loads.
  83.           
  84.         Allowing  the  Sysop to choose between the two  chat  facilities  is 
  85.         needed,  as  the ChatBox facility is, after all, a  'door'  and  the 
  86.         caller  must  be at the PCBoard main prompt in order  for  the  PAGE 
  87.         (door) command to be entered. The PCBoard chat facility needs to  be 
  88.         used if chatting  is required when the caller is not at the  PCBoard 
  89.         main prompt. A good example for needing to use PCBoard's chat  would 
  90.         be if a caller needed assistance while entering a message.
  91.  
  92.         Set_F10  works  by  popping up a window,  where  the  Sysop  chooses 
  93.         ChatBox  or PCBoard. If ChatBox is chosen, PAGE is typed in  at  the 
  94.         PCBoard prompt along with the necessary steps required  for  ChatBox 
  95.         to know the Sysop is initiating the chat.  If PCBoard is chosen, the 
  96.         F10 keystroke is processed normally and the PCBoard chat begins.
  97.           
  98.         Set_F10  may not be for everyone.  If you do not wish to use Set_F10
  99.         or  if  Set_F10  does  not work on  your  system,  use  the  ChatBox 
  100.         documented  method  of  defining the  PCBoard  SHIFT-F10 (key press) 
  101.         for initiating a caller chat with ChatBox, and F10 for a chat  using 
  102.         PCBoard's chat.
  103.           
  104.                     
  105.         1.1  Disclaimer
  106.         ---------------
  107.         Set_F10  is a no-charge enhancement utility for ChatBox. It  is  not 
  108.         part  of  the  ChatBox  product.  It  is  included  in  the  ChatBox 
  109.         distribution file solely to facilitate ease of distribution.
  110.  
  111.         There  are no warranties, expressed or implied, for Set_F10.  Sysops 
  112.         who install Set_F10 on their systems assume any and all  liabilities 
  113.         for anything which may result as a consequence of running Set_F10. 
  114.  
  115.         Under no circumstances shall Yandell Computer Services or the author
  116.         of Set_F10 be liable for any loss of profit or  any  other  damages, 
  117.         including but not limited to special, incidental, consequential,  or 
  118.         other damages, arising out of the use or inability to use Set_F10.
  119.  
  120.  
  121.         PCBoard is a registered trademark of Clark Development Co. Inc.
  122.         DESQview is a registered trademark of Quarterdeck Office Systems.
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.         --------------------------------------------------------------------
  136.         Page 3                       Set_F10                          Page 3
  137.         --------------------------------------------------------------------
  138.  
  139.         2.0  Installing Set_F10 in BOARD.BAT
  140.         ------------------------------------
  141.         Place SET_F10.EXE in a path.  In each node's BOARD.BAT place SET_F10 
  142.         immediately BEFORE PCB145.EXE is called.  Put SET_F10 /U immediately 
  143.         AFTER PCB145.EXE in BOARD.BAT so it will not be  present outside  of 
  144.         the PCBoard environment.
  145.  
  146.         (BOARD.BAT fragment)
  147.  
  148.         SET_F10.EXE
  149.         PCB145.EXE
  150.         SET_F10.EXE /U 
  151.  
  152.         /U stands for Uninstall.
  153.  
  154.         You may add /S as a command line option to suppress installation and
  155.         de-installation messages from appearing on the local screen.
  156.         
  157.  
  158.         2.1  Installing if ChatBox door name is not PAGE
  159.         ------------------------------------------------
  160.         The  recommended  use for ChatBox is to call it a door  named  PAGE. 
  161.         Set_F10  allows other names to be used.  Simply place /C:name  after 
  162.         the first call to SET_F10.EXE in BOARD.BAT, where "name" is what the
  163.         ChatBox door is called. For example:
  164.  
  165.         (BOARD.BAT fragment)
  166.  
  167.         SET_F10.EXE /C:TALK
  168.         PCB145.EXE
  169.         SET_F10.EXE /U 
  170.  
  171.         The  above  example would be for an installation where  ChatBox  had 
  172.         been installed as a door called TALK.
  173.  
  174.         IMPORTANT: If the /S (suppress) and /C: parameters are used, /S must 
  175.         appear first on the command line.
  176.  
  177.         If you have called the ChatBox door PAGE, the /C:name parameter does 
  178.         not need to be used.
  179.           
  180.         TIP:  Alternate names such as /C:SYSOP CHAT ON   can be used. Simply
  181.         duplicate the PAGE door batch file and call it SYSOP. Then duplicate
  182.         the PAGE door entry in DOORS.LST, calling it SYSOP also.  Then  load
  183.         Set_F10  with the  /C:SYSOP CHAT ON  command line.  When ChatBox  is 
  184.         selected, SYSOP CHAT ON will be entered at the PCBoard main  prompt,
  185.         PCBoard will load the SYSOP door (which is actually your PAGE  door, 
  186.         and the CHAT ON portion of the command line will be ignored. Callers 
  187.         who  try  to be clever and type SYSOP CHAT ON themselves  are  doing 
  188.         exactly the same as if they enter the PAGE command!
  189.                     
  190.         IMPORTANT: Alternate names are limited to 14 characters in length.
  191.                               
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.         --------------------------------------------------------------------
  202.         Page 4                        Set_F10                         Page 4
  203.         --------------------------------------------------------------------
  204.  
  205.         3.0  Using Set_F10          
  206.         ------------------
  207.         When F10 is pressed by the local Sysop, a box appears at the top  of 
  208.         the local screen (only). The Sysop may choose whether to use ChatBox
  209.         or PCBoard for chatting with the caller.  Pressing SPACE will toggle 
  210.         the highlighted selection between ChatBox or PCBoard. Pressing ENTER 
  211.         will begin the chat with the program which was highlighted. Pressing
  212.         ESC aborts the F10 request.
  213.  
  214.         The caller must be at the PCBoard main command prompt if ChatBox  is 
  215.         to be selected.  Set_F10 will enter the PAGE (door) command and also 
  216.         take  care of a couple of extra steps so that ChatBox will know  the 
  217.         Sysop is initiating the chat (please see the technical notes on page 
  218.         number 4 of this document for more information).
  219.                     
  220.         If  PCBoard is selected, the F10 key press is passed on  to  PCBoard 
  221.         and PCBoard will begin a chat.
  222.           
  223.  
  224.  
  225.         3.1  F10 key use with other programs
  226.         ------------------------------------
  227.         If  Set_F10 has been installed as prescribed in this  documentation, 
  228.         it will be uninstalled every time PCBoard exits.  This includes non-
  229.         shell  door exits and Sysop termination of PCBoard.  This absolutely 
  230.         requires  Set_F10 to be installed exactly as illustrated on  page #2 
  231.         section 2.0 of this manual.
  232.                               
  233.         Set_F10 has the ability to detect when "shelled to" applications are 
  234.         running under PCBoard. "Shelled to" applications are doors which are 
  235.         shelled to (such as ChatBox), the File View function (such as PCBFV)
  236.         and the TEST function (PCBTEST.BAT).  When any of  these  conditions 
  237.         are  detected,  Set_F10  will pass F10 key strokes directly  to  the 
  238.         underlying  application  as  normal F10's, without  popping  up  the 
  239.         ChatBox\PCBoard selection window.
  240.                   
  241.  
  242.  
  243.         3.2  In case of difficulty   
  244.         --------------------------   
  245.         Set_F10  has been thoroughly tested and worked 100% as  expected  at 
  246.         all  beta test sites.  However, TSR's are by their very nature  very 
  247.         particular about the environments where they run. 
  248.  
  249.         If  Set_F10  does not function properly, make sure it  is  installed 
  250.         exactly  as  described in this documentation.  If it still does  not 
  251.         function  properly,  you  will need to set  the  SHIFT-F10  key  for 
  252.         initiating a caller chat as described in the Chatbox manual.
  253.                                    
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.         --------------------------------------------------------------------
  268.         Page 5                        Set_F10                         Page 5
  269.         --------------------------------------------------------------------
  270.  
  271.         4.0  DOS "errorlevel" use in BOARD.BAT
  272.         --------------------------------------
  273.         Set_F10  does  not pass DOS "errorlevel" conditions through  to  the 
  274.         next process when Set_F10 /U is used.  If you use DOS'  "errorlevel" 
  275.         condition  testing  in BOARD.BAT, you should set a  label  for  each 
  276.         condition  and branch to the label if the "errorlevel" condition  is 
  277.         met.  You should uninstall (/U) Set_F10 at EACH label,  rather  than 
  278.         immediately after PCB145.EXE  executes as described earlier in  this 
  279.         documentation.
  280.  
  281.  
  282.         4.1  Technical notes
  283.         --------------------
  284.         ChatBox  must be loaded within 30 seconds after selecting  "ChatBox" 
  285.         from the Set_F10 menu in order for ChatBox to start in  "Sysop chat"
  286.         mode. This 30 second feature is a safety net in the unlikely event a 
  287.         Sysop  issues a ChatBox request and ChatBox fails to  load,  thereby 
  288.         leaving the "start in Sysop chat mode" instructions in memory. If  a 
  289.         caller  subsequently enters a PAGE request and "start in Sysop  chat 
  290.         mode"  instructions  are  still  in  memory  (again,  unlikely)  the 
  291.         instructions  will be ignored if they are more than 30  seconds old,
  292.         and ChatBox will start in "caller page" mode.
  293.   
  294.         Set_F10  automatically "pops down" 10 seconds after it is popped  up 
  295.         in case of an accidental F10 key press.
  296.  
  297.         The  contents of the screen which existed before the  selection  box 
  298.         "pops up" are re-drawn by Set_F10 when it "pops down".
  299.  
  300.         PCBoard  does  not act on F10 key presses in local mode.  Therefore, 
  301.         when  selecting PCBoard from the Set_F10 selection window  in  local 
  302.         mode, it will appear nothing happens.  This is normal. There must be 
  303.         a caller on-line to initiate a PCBoard chat with F10.  If ChatBox is 
  304.         selected  while in local mode, Set_F10 will behave exactly as  if  a 
  305.         caller were on-line and start the ChatBox session.
  306.                     
  307.         Set_F10's screen I/O is DESQview aware.
  308.  
  309.         Set_F10 uses about 9K of memory.
  310.  
  311.  
  312.